<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class wikipediaapi</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class wikipediaapi</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This class is for interacting with Wikipedia's api.php API.</p>
		<p class="notes">
			Located in <a class="field" href="_wikibot.classes.php.html">/wikibot.classes.php</a> (line <span class="field">160</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>



	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
																								<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$apiurl" title="details" class="var-name">$apiurl</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																																																																																												
												<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">Associative</span>
										<a href="#backlinks" title="details" class="method-name">backlinks</a>
											(<span class="var-type">$page</span>&nbsp;<span class="var-name">$page</span>, [<span class="var-type">$count</span>&nbsp;<span class="var-name">$count</span> = <span class="var-default">500</span>], [<span class="var-type">$filter</span>&nbsp;<span class="var-name">&$continue</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$filter</span> = <span class="var-default">null</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">Associative</span>
										<a href="#categorymembers" title="details" class="method-name">categorymembers</a>
											(<span class="var-type">$category</span>&nbsp;<span class="var-name">$category</span>, [<span class="var-type">$count</span>&nbsp;<span class="var-name">$count</span> = <span class="var-default">500</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">&$continue</span> = <span class="var-default">null</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">boolean</span>
										<a href="#edit" title="details" class="method-name">edit</a>
											(<span class="var-type">$page</span>&nbsp;<span class="var-name">$page</span>, <span class="var-type">$data</span>&nbsp;<span class="var-name">$data</span>, [<span class="var-type">$summary</span>&nbsp;<span class="var-name">$summary</span> = <span class="var-default">''</span>], [<span class="var-type">$minor</span>&nbsp;<span class="var-name">$minor</span> = <span class="var-default">false</span>], [<span class="var-type">$bot</span>&nbsp;<span class="var-name">$bot</span> = <span class="var-default">true</span>], [<span class="var-type">$wpStarttime</span>&nbsp;<span class="var-name">$wpStarttime</span> = <span class="var-default">null</span>], [<span class="var-type">$wpEdittime</span>&nbsp;<span class="var-name">$wpEdittime</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$checkrun</span> = <span class="var-default">true</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">Associative</span>
										<a href="#embeddedin" title="details" class="method-name">embeddedin</a>
											(<span class="var-type">$page</span>&nbsp;<span class="var-name">$page</span>, [<span class="var-type">$count</span>&nbsp;<span class="var-name">$count</span> = <span class="var-default">500</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">&$continue</span> = <span class="var-default">null</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">Edit</span>
										<a href="#getedittoken" title="details" class="method-name">getedittoken</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">An</span>
										<a href="#gettokens" title="details" class="method-name">gettokens</a>
											(<span class="var-type">$title</span>&nbsp;<span class="var-name">$title</span>, [<span class="var-type">$flush</span>&nbsp;<span class="var-name">$flush</span> = <span class="var-default">false</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">Associative</span>
										<a href="#listcategories" title="details" class="method-name">listcategories</a>
											([<span class="var-type">$limit</span>&nbsp;<span class="var-name">&$start</span> = <span class="var-default">null</span>], [<span class="var-type">$dir</span>&nbsp;<span class="var-name">$limit</span> = <span class="var-default">50</span>], [<span class="var-type">$prefix</span>&nbsp;<span class="var-name">$dir</span> = <span class="var-default">'ascending'</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">null</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">Associative</span>
										<a href="#listprefix" title="details" class="method-name">listprefix</a>
											(<span class="var-type">$prefix</span>&nbsp;<span class="var-name">$prefix</span>, [<span class="var-type">$namespace</span>&nbsp;<span class="var-name">$namespace</span> = <span class="var-default">0</span>], [<span class="var-type">$count</span>&nbsp;<span class="var-name">$count</span> = <span class="var-default">500</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">&$continue</span> = <span class="var-default">null</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#login" title="details" class="method-name">login</a>
											(<span class="var-type">$user</span>&nbsp;<span class="var-name">$user</span>, <span class="var-type">$pass</span>&nbsp;<span class="var-name">$pass</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">Associative</span>
										<a href="#logs" title="details" class="method-name">logs</a>
											([<span class="var-type">$user</span>&nbsp;<span class="var-name">$user</span> = <span class="var-default">null</span>], [<span class="var-type">$title</span>&nbsp;<span class="var-name">$title</span> = <span class="var-default">null</span>], [<span class="var-type">$limit</span>&nbsp;<span class="var-name">$limit</span> = <span class="var-default">50</span>], [<span class="var-type">$type</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>], [<span class="var-type">$start</span>&nbsp;<span class="var-name">$start</span> = <span class="var-default">null</span>], [<span class="var-type">$end</span>&nbsp;<span class="var-name">$end</span> = <span class="var-default">null</span>], [<span class="var-type">$dir</span>&nbsp;<span class="var-name">$dir</span> = <span class="var-default">'older'</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#move" title="details" class="method-name">move</a>
											(<span class="var-type">$old</span>&nbsp;<span class="var-name">$old</span>, <span class="var-type">$new</span>&nbsp;<span class="var-name">$new</span>, <span class="var-type">$reason</span>&nbsp;<span class="var-name">$reason</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">Associative</span>
										<a href="#recentchanges" title="details" class="method-name">recentchanges</a>
											([<span class="var-type">$count</span>&nbsp;<span class="var-name">$count</span> = <span class="var-default">10</span>], [<span class="var-type">$namespace</span>&nbsp;<span class="var-name">$namespace</span> = <span class="var-default">null</span>], [<span class="var-type">$dir</span>&nbsp;<span class="var-name">$dir</span> = <span class="var-default">'older'</span>], [<span class="var-type">$ts</span>&nbsp;<span class="var-name">$ts</span> = <span class="var-default">null</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">Associative</span>
										<a href="#revisions" title="details" class="method-name">revisions</a>
											(<span class="var-type">$page</span>&nbsp;<span class="var-name">$page</span>, [<span class="var-type">$count</span>&nbsp;<span class="var-name">$count</span> = <span class="var-default">1</span>], [<span class="var-type">$dir</span>&nbsp;<span class="var-name">$dir</span> = <span class="var-default">'older'</span>], [<span class="var-type">$content</span>&nbsp;<span class="var-name">$content</span> = <span class="var-default">false</span>], [<span class="var-type">$revid</span>&nbsp;<span class="var-name">$revid</span> = <span class="var-default">null</span>], [<span class="var-type">$wait</span>&nbsp;<span class="var-name">$wait</span> = <span class="var-default">true</span>], [<span class="var-type">$getrbtok</span>&nbsp;<span class="var-name">$getrbtok</span> = <span class="var-default">false</span>], [<span class="var-type">$dieonerror</span>&nbsp;<span class="var-name">$dieonerror</span> = <span class="var-default">true</span>], [<span class="var-type">$redirects</span>&nbsp;<span class="var-name">$redirects</span> = <span class="var-default">false</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#rollback" title="details" class="method-name">rollback</a>
											(<span class="var-type">$title</span>&nbsp;<span class="var-name">$title</span>, <span class="var-type">$user</span>&nbsp;<span class="var-name">$user</span>, <span class="var-type">$reason</span>&nbsp;<span class="var-name">$reason</span>, [<span class="var-type">$token</span>&nbsp;<span class="var-name">$token</span> = <span class="var-default">null</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">Associative</span>
										<a href="#search" title="details" class="method-name">search</a>
											(<span class="var-type">$search</span>&nbsp;<span class="var-name">$search</span>, [<span class="var-type">$limit</span>&nbsp;<span class="var-name">$limit</span> = <span class="var-default">10</span>], [<span class="var-type">$offset</span>&nbsp;<span class="var-name">$offset</span> = <span class="var-default">0</span>], [<span class="var-type">$namespace</span>&nbsp;<span class="var-name">$namespace</span> = <span class="var-default">0</span>], [<span class="var-type">$what</span>&nbsp;<span class="var-name">$what</span> = <span class="var-default">'text'</span>], [<span class="var-type">$redirs</span>&nbsp;<span class="var-name">$redirs</span> = <span class="var-default">false</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#siteinfo" title="details" class="method-name">siteinfo</a>
											([<span class="var-type"></span>&nbsp;<span class="var-name">$replace_apiurl</span> = <span class="var-default">null</span>], <span class="var-type"></span>&nbsp;<span class="var-name">$statistics</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">Associative</span>
										<a href="#usercontribs" title="details" class="method-name">usercontribs</a>
											(<span class="var-type">$user</span>&nbsp;<span class="var-name">$user</span>, [<span class="var-type">$count</span>&nbsp;<span class="var-name">$count</span> = <span class="var-default">50</span>], [<span class="var-type">$dir</span>&nbsp;<span class="var-name">&$continue</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$dir</span> = <span class="var-default">'older'</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">Associative</span>
										<a href="#users" title="details" class="method-name">users</a>
											([<span class="var-type">$start</span>&nbsp;<span class="var-name">$start</span> = <span class="var-default">null</span>], [<span class="var-type">$limit</span>&nbsp;<span class="var-name">$limit</span> = <span class="var-default">1</span>], [<span class="var-type">$group</span>&nbsp;<span class="var-name">$group</span> = <span class="var-default">null</span>], [<span class="var-type">$requirestart</span>&nbsp;<span class="var-name">$requirestart</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">&$continue</span> = <span class="var-default">null</span>])
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$apiurl" id="$apiurl"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$apiurl</span>
			 = <span class="var-default"> 'http://rappelz.wikia.com/api.php'</span>			(line <span class="line-number">165</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">171</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This is our constructor.</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			__construct
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodbacklinks" id="backlinks"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">backlinks</span> (line <span class="line-number">465</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Enumerate all backlinks to a page.</p>
	<ul class="tags">
				<li><span class="field">return:</span> array of backlink metadata.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Associative</span>
		<span class="method-name">
			backlinks
		</span>
					(<span class="var-type">$page</span>&nbsp;<span class="var-name">$page</span>, [<span class="var-type">$count</span>&nbsp;<span class="var-name">$count</span> = <span class="var-default">500</span>], [<span class="var-type">$filter</span>&nbsp;<span class="var-name">&$continue</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$filter</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$page</span>
				<span class="var-name">$page</span><span class="var-description">: Page to search for backlinks to.</span>			</li>
					<li>
				<span class="var-type">$count</span>
				<span class="var-name">$count</span><span class="var-description">: Number of backlinks to list.  (Default 500)</span>			</li>
					<li>
				<span class="var-type">$filter</span>
				<span class="var-name">&$continue</span><span class="var-description">: Whether or not to include redirects.  Acceptible values are 'all', 'redirects', and 'nonredirects'.  (Default null)</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$filter</span>			</li>
				</ul>
		
			
	</div>
<a name="methodcategorymembers" id="categorymembers"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">categorymembers</span> (line <span class="line-number">410</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get members of a category.</p>
	<ul class="tags">
				<li><span class="field">return:</span> array of category member metadata.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Associative</span>
		<span class="method-name">
			categorymembers
		</span>
					(<span class="var-type">$category</span>&nbsp;<span class="var-name">$category</span>, [<span class="var-type">$count</span>&nbsp;<span class="var-name">$count</span> = <span class="var-default">500</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">&$continue</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$category</span>
				<span class="var-name">$category</span><span class="var-description">: Category to enumerate from.</span>			</li>
					<li>
				<span class="var-type">$count</span>
				<span class="var-name">$count</span><span class="var-description">: Number of members to enumerate.  (Default 500)</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">&$continue</span>			</li>
				</ul>
		
			
	</div>
<a name="methodedit" id="edit"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">edit</span> (line <span class="line-number">530</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Edits a page.</p>
	<ul class="tags">
				<li><span class="field">return:</span> True on success, false on failure.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			edit
		</span>
					(<span class="var-type">$page</span>&nbsp;<span class="var-name">$page</span>, <span class="var-type">$data</span>&nbsp;<span class="var-name">$data</span>, [<span class="var-type">$summary</span>&nbsp;<span class="var-name">$summary</span> = <span class="var-default">''</span>], [<span class="var-type">$minor</span>&nbsp;<span class="var-name">$minor</span> = <span class="var-default">false</span>], [<span class="var-type">$bot</span>&nbsp;<span class="var-name">$bot</span> = <span class="var-default">true</span>], [<span class="var-type">$wpStarttime</span>&nbsp;<span class="var-name">$wpStarttime</span> = <span class="var-default">null</span>], [<span class="var-type">$wpEdittime</span>&nbsp;<span class="var-name">$wpEdittime</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$checkrun</span> = <span class="var-default">true</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$page</span>
				<span class="var-name">$page</span><span class="var-description">: Page name to edit.</span>			</li>
					<li>
				<span class="var-type">$data</span>
				<span class="var-name">$data</span><span class="var-description">: Data to post to page.</span>			</li>
					<li>
				<span class="var-type">$summary</span>
				<span class="var-name">$summary</span><span class="var-description">: Edit summary to use.</span>			</li>
					<li>
				<span class="var-type">$minor</span>
				<span class="var-name">$minor</span><span class="var-description">: Whether or not to mark edit as minor.  (Default false)</span>			</li>
					<li>
				<span class="var-type">$bot</span>
				<span class="var-name">$bot</span><span class="var-description">: Whether or not to mark edit as a bot edit.  (Default true)</span>			</li>
					<li>
				<span class="var-type">$wpStarttime</span>
				<span class="var-name">$wpStarttime</span><span class="var-description">: Time in MW TS format of beginning of edit.  (Default now)</span>			</li>
					<li>
				<span class="var-type">$wpEdittime</span>
				<span class="var-name">$wpEdittime</span><span class="var-description">: Time in MW TS format of last edit to that page.  (Default correct)</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$checkrun</span>			</li>
				</ul>
		
			
	</div>
<a name="methodembeddedin" id="embeddedin"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">embeddedin</span> (line <span class="line-number">488</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets a list of transcludes embedded in a page.</p>
	<ul class="tags">
				<li><span class="field">return:</span> array of transclude metadata.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Associative</span>
		<span class="method-name">
			embeddedin
		</span>
					(<span class="var-type">$page</span>&nbsp;<span class="var-name">$page</span>, [<span class="var-type">$count</span>&nbsp;<span class="var-name">$count</span> = <span class="var-default">500</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">&$continue</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$page</span>
				<span class="var-name">$page</span><span class="var-description">: Page to look for transcludes in.</span>			</li>
					<li>
				<span class="var-type">$count</span>
				<span class="var-name">$count</span><span class="var-description">: Number of transcludes to list.  (Default 500)</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">&$continue</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetedittoken" id="getedittoken"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getedittoken</span> (line <span class="line-number">203</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This function returns the edit token.</p>
	<ul class="tags">
				<li><span class="field">return:</span> token.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Edit</span>
		<span class="method-name">
			getedittoken
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgettokens" id="gettokens"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">gettokens</span> (line <span class="line-number">216</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This function returns the various tokens for a certain page.</p>
	<ul class="tags">
				<li><span class="field">return:</span> associative array of tokens for the page.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">An</span>
		<span class="method-name">
			gettokens
		</span>
					(<span class="var-type">$title</span>&nbsp;<span class="var-name">$title</span>, [<span class="var-type">$flush</span>&nbsp;<span class="var-name">$flush</span> = <span class="var-default">false</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$title</span>
				<span class="var-name">$title</span><span class="var-description">: Page to get the tokens for.</span>			</li>
					<li>
				<span class="var-type">$flush</span>
				<span class="var-name">$flush</span><span class="var-description">: Optional - internal use only.  Flushes the token cache.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodlistcategories" id="listcategories"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">listcategories</span> (line <span class="line-number">442</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Enumerate all categories.</p>
	<ul class="tags">
				<li><span class="field">return:</span> array of category list metadata.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Associative</span>
		<span class="method-name">
			listcategories
		</span>
					([<span class="var-type">$limit</span>&nbsp;<span class="var-name">&$start</span> = <span class="var-default">null</span>], [<span class="var-type">$dir</span>&nbsp;<span class="var-name">$limit</span> = <span class="var-default">50</span>], [<span class="var-type">$prefix</span>&nbsp;<span class="var-name">$dir</span> = <span class="var-default">'ascending'</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$limit</span>
				<span class="var-name">&$start</span><span class="var-description">: Number of categories to enumerate.  (Default 50)</span>			</li>
					<li>
				<span class="var-type">$dir</span>
				<span class="var-name">$limit</span><span class="var-description">: Direction to enumerate in.  'ascending' or 'descending'.  (Default 'ascending')</span>			</li>
					<li>
				<span class="var-type">$prefix</span>
				<span class="var-name">$dir</span><span class="var-description">: Only enumerate categories with this prefix.  (Default null)</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$prefix</span>			</li>
				</ul>
		
			
	</div>
<a name="methodlistprefix" id="listprefix"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">listprefix</span> (line <span class="line-number">508</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets a list of pages with a common prefix.</p>
	<ul class="tags">
				<li><span class="field">return:</span> array of page metadata.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Associative</span>
		<span class="method-name">
			listprefix
		</span>
					(<span class="var-type">$prefix</span>&nbsp;<span class="var-name">$prefix</span>, [<span class="var-type">$namespace</span>&nbsp;<span class="var-name">$namespace</span> = <span class="var-default">0</span>], [<span class="var-type">$count</span>&nbsp;<span class="var-name">$count</span> = <span class="var-default">500</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">&$continue</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$prefix</span>
				<span class="var-name">$prefix</span><span class="var-description">: Common prefix to search for.</span>			</li>
					<li>
				<span class="var-type">$namespace</span>
				<span class="var-name">$namespace</span><span class="var-description">: Numeric namespace to filter on.  (Default 0)</span>			</li>
					<li>
				<span class="var-type">$count</span>
				<span class="var-name">$count</span><span class="var-description">: Number of pages to list.  (Default 500)</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">&$continue</span>			</li>
				</ul>
		
			
	</div>
<a name="methodlogin" id="login"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">login</span> (line <span class="line-number">185</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This function takes a username and password and logs you into wikipedia.</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			login
		</span>
					(<span class="var-type">$user</span>&nbsp;<span class="var-name">$user</span>, <span class="var-type">$pass</span>&nbsp;<span class="var-name">$pass</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$user</span>
				<span class="var-name">$user</span><span class="var-description">: Username to login as.</span>			</li>
					<li>
				<span class="var-type">$pass</span>
				<span class="var-name">$pass</span><span class="var-description">: Password that corrisponds to the username.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodlogs" id="logs"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">logs</span> (line <span class="line-number">294</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Retrieve entries from the WikiLog.</p>
	<ul class="tags">
				<li><span class="field">return:</span> array of logs metadata.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Associative</span>
		<span class="method-name">
			logs
		</span>
					([<span class="var-type">$user</span>&nbsp;<span class="var-name">$user</span> = <span class="var-default">null</span>], [<span class="var-type">$title</span>&nbsp;<span class="var-name">$title</span> = <span class="var-default">null</span>], [<span class="var-type">$limit</span>&nbsp;<span class="var-name">$limit</span> = <span class="var-default">50</span>], [<span class="var-type">$type</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>], [<span class="var-type">$start</span>&nbsp;<span class="var-name">$start</span> = <span class="var-default">null</span>], [<span class="var-type">$end</span>&nbsp;<span class="var-name">$end</span> = <span class="var-default">null</span>], [<span class="var-type">$dir</span>&nbsp;<span class="var-name">$dir</span> = <span class="var-default">'older'</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$user</span>
				<span class="var-name">$user</span><span class="var-description">: Username who caused the entry.  Null means anyone.  (Default null)</span>			</li>
					<li>
				<span class="var-type">$title</span>
				<span class="var-name">$title</span><span class="var-description">: Object to which the entry refers.  Null means anything.  (Default null)</span>			</li>
					<li>
				<span class="var-type">$limit</span>
				<span class="var-name">$limit</span><span class="var-description">: Number of entries to return.  (Default 50)</span>			</li>
					<li>
				<span class="var-type">$type</span>
				<span class="var-name">$type</span><span class="var-description">: Type of logs.  Null means any type.  (Default null)</span>			</li>
					<li>
				<span class="var-type">$start</span>
				<span class="var-name">$start</span><span class="var-description">: Date to start enumerating logs.  Null means beginning/end depending on $dir.  (Default null)</span>			</li>
					<li>
				<span class="var-type">$end</span>
				<span class="var-name">$end</span><span class="var-description">: Where to stop enumerating logs.  Null means whenever limit is satisfied or there are no more logs.  (Default null)</span>			</li>
					<li>
				<span class="var-type">$dir</span>
				<span class="var-name">$dir</span><span class="var-description">: Direction to enumerate logs.  &quot;older&quot; or &quot;newer&quot;.  (Default 'older')</span>			</li>
				</ul>
		
			
	</div>
<a name="methodmove" id="move"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">move</span> (line <span class="line-number">575</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Moves a page.</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			move
		</span>
					(<span class="var-type">$old</span>&nbsp;<span class="var-name">$old</span>, <span class="var-type">$new</span>&nbsp;<span class="var-name">$new</span>, <span class="var-type">$reason</span>&nbsp;<span class="var-name">$reason</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$old</span>
				<span class="var-name">$old</span><span class="var-description">: Name of page to move.</span>			</li>
					<li>
				<span class="var-type">$new</span>
				<span class="var-name">$new</span><span class="var-description">: New page title.</span>			</li>
					<li>
				<span class="var-type">$reason</span>
				<span class="var-name">$reason</span><span class="var-description">: Move summary to use.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodrecentchanges" id="recentchanges"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">recentchanges</span> (line <span class="line-number">250</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This function returns the recent changes for the wiki.</p>
	<ul class="tags">
				<li><span class="field">return:</span> array of recent changes metadata.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Associative</span>
		<span class="method-name">
			recentchanges
		</span>
					([<span class="var-type">$count</span>&nbsp;<span class="var-name">$count</span> = <span class="var-default">10</span>], [<span class="var-type">$namespace</span>&nbsp;<span class="var-name">$namespace</span> = <span class="var-default">null</span>], [<span class="var-type">$dir</span>&nbsp;<span class="var-name">$dir</span> = <span class="var-default">'older'</span>], [<span class="var-type">$ts</span>&nbsp;<span class="var-name">$ts</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$count</span>
				<span class="var-name">$count</span><span class="var-description">: The number of items to return. (Default 10)</span>			</li>
					<li>
				<span class="var-type">$namespace</span>
				<span class="var-name">$namespace</span><span class="var-description">: The namespace ID to filter items on. Null for no filtering. (Default null)</span>			</li>
					<li>
				<span class="var-type">$dir</span>
				<span class="var-name">$dir</span><span class="var-description">: The direction to pull items.  &quot;older&quot; or &quot;newer&quot;.  (Default 'older')</span>			</li>
					<li>
				<span class="var-type">$ts</span>
				<span class="var-name">$ts</span><span class="var-description">: The timestamp to start at.  Null for the beginning/end (depending on direction).  (Default null)</span>			</li>
				</ul>
		
			
	</div>
<a name="methodrevisions" id="revisions"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">revisions</span> (line <span class="line-number">341</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns revision data (meta and/or actual).</p>
	<ul class="tags">
				<li><span class="field">return:</span> array of revision data.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Associative</span>
		<span class="method-name">
			revisions
		</span>
					(<span class="var-type">$page</span>&nbsp;<span class="var-name">$page</span>, [<span class="var-type">$count</span>&nbsp;<span class="var-name">$count</span> = <span class="var-default">1</span>], [<span class="var-type">$dir</span>&nbsp;<span class="var-name">$dir</span> = <span class="var-default">'older'</span>], [<span class="var-type">$content</span>&nbsp;<span class="var-name">$content</span> = <span class="var-default">false</span>], [<span class="var-type">$revid</span>&nbsp;<span class="var-name">$revid</span> = <span class="var-default">null</span>], [<span class="var-type">$wait</span>&nbsp;<span class="var-name">$wait</span> = <span class="var-default">true</span>], [<span class="var-type">$getrbtok</span>&nbsp;<span class="var-name">$getrbtok</span> = <span class="var-default">false</span>], [<span class="var-type">$dieonerror</span>&nbsp;<span class="var-name">$dieonerror</span> = <span class="var-default">true</span>], [<span class="var-type">$redirects</span>&nbsp;<span class="var-name">$redirects</span> = <span class="var-default">false</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$page</span>
				<span class="var-name">$page</span><span class="var-description">: Page for which to return revision data for.</span>			</li>
					<li>
				<span class="var-type">$count</span>
				<span class="var-name">$count</span><span class="var-description">: Number of revisions to return. (Default 1)</span>			</li>
					<li>
				<span class="var-type">$dir</span>
				<span class="var-name">$dir</span><span class="var-description">: Direction to start enumerating multiple revisions from, &quot;older&quot; or &quot;newer&quot;. (Default 'older')</span>			</li>
					<li>
				<span class="var-type">$content</span>
				<span class="var-name">$content</span><span class="var-description">: Whether to return actual revision content, true or false.  (Default false)</span>			</li>
					<li>
				<span class="var-type">$revid</span>
				<span class="var-name">$revid</span><span class="var-description">: Revision ID to start at.  (Default null)</span>			</li>
					<li>
				<span class="var-type">$wait</span>
				<span class="var-name">$wait</span><span class="var-description">: Whether or not to wait a few seconds for the specific revision to become available.  (Default true)</span>			</li>
					<li>
				<span class="var-type">$getrbtok</span>
				<span class="var-name">$getrbtok</span><span class="var-description">: Whether or not to retrieve a rollback token for the revision.  (Default false)</span>			</li>
					<li>
				<span class="var-type">$dieonerror</span>
				<span class="var-name">$dieonerror</span><span class="var-description">: Whether or not to kill the process with an error if an error occurs.  (Default false)</span>			</li>
					<li>
				<span class="var-type">$redirects</span>
				<span class="var-name">$redirects</span><span class="var-description">: Whether or not to follow redirects.  (Default false)</span>			</li>
				</ul>
		
			
	</div>
<a name="methodrollback" id="rollback"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">rollback</span> (line <span class="line-number">599</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Rollback an edit.</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			rollback
		</span>
					(<span class="var-type">$title</span>&nbsp;<span class="var-name">$title</span>, <span class="var-type">$user</span>&nbsp;<span class="var-name">$user</span>, <span class="var-type">$reason</span>&nbsp;<span class="var-name">$reason</span>, [<span class="var-type">$token</span>&nbsp;<span class="var-name">$token</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$title</span>
				<span class="var-name">$title</span><span class="var-description">: Title of page to rollback.</span>			</li>
					<li>
				<span class="var-type">$user</span>
				<span class="var-name">$user</span><span class="var-description">: Username of last edit to the page to rollback.</span>			</li>
					<li>
				<span class="var-type">$reason</span>
				<span class="var-name">$reason</span><span class="var-description">: Edit summary to use for rollback.</span>			</li>
					<li>
				<span class="var-type">$token</span>
				<span class="var-name">$token</span><span class="var-description">: Rollback token.  If not given, it will be fetched.  (Default null)</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsearch" id="search"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">search</span> (line <span class="line-number">270</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This function returns search results from Wikipedia's internal search engine.</p>
	<ul class="tags">
				<li><span class="field">return:</span> array of search result metadata.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Associative</span>
		<span class="method-name">
			search
		</span>
					(<span class="var-type">$search</span>&nbsp;<span class="var-name">$search</span>, [<span class="var-type">$limit</span>&nbsp;<span class="var-name">$limit</span> = <span class="var-default">10</span>], [<span class="var-type">$offset</span>&nbsp;<span class="var-name">$offset</span> = <span class="var-default">0</span>], [<span class="var-type">$namespace</span>&nbsp;<span class="var-name">$namespace</span> = <span class="var-default">0</span>], [<span class="var-type">$what</span>&nbsp;<span class="var-name">$what</span> = <span class="var-default">'text'</span>], [<span class="var-type">$redirs</span>&nbsp;<span class="var-name">$redirs</span> = <span class="var-default">false</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$search</span>
				<span class="var-name">$search</span><span class="var-description">: The query string to search for.</span>			</li>
					<li>
				<span class="var-type">$limit</span>
				<span class="var-name">$limit</span><span class="var-description">: The number of results to return. (Default 10)</span>			</li>
					<li>
				<span class="var-type">$offset</span>
				<span class="var-name">$offset</span><span class="var-description">: The number to start at.  (Default 0)</span>			</li>
					<li>
				<span class="var-type">$namespace</span>
				<span class="var-name">$namespace</span><span class="var-description">: The namespace ID to filter by.  Null means no filtering.  (Default 0)</span>			</li>
					<li>
				<span class="var-type">$what</span>
				<span class="var-name">$what</span><span class="var-description">: What to search, 'text' or 'title'.  (Default 'text')</span>			</li>
					<li>
				<span class="var-type">$redirs</span>
				<span class="var-name">$redirs</span><span class="var-description">: Whether or not to list redirects.  (Default false)</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsiteinfo" id="siteinfo"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">siteinfo</span> (line <span class="line-number">630</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			siteinfo
		</span>
					([<span class="var-type"></span>&nbsp;<span class="var-name">$replace_apiurl</span> = <span class="var-default">null</span>], <span class="var-type"></span>&nbsp;<span class="var-name">$statistics</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$replace_apiurl</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$statistics</span>			</li>
				</ul>
		
			
	</div>
<a name="methodusercontribs" id="usercontribs"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">usercontribs</span> (line <span class="line-number">316</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Retrieves metadata about a user's contributions.</p>
	<ul class="tags">
				<li><span class="field">return:</span> array of contributions metadata.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Associative</span>
		<span class="method-name">
			usercontribs
		</span>
					(<span class="var-type">$user</span>&nbsp;<span class="var-name">$user</span>, [<span class="var-type">$count</span>&nbsp;<span class="var-name">$count</span> = <span class="var-default">50</span>], [<span class="var-type">$dir</span>&nbsp;<span class="var-name">&$continue</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$dir</span> = <span class="var-default">'older'</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$user</span>
				<span class="var-name">$user</span><span class="var-description">: Username whose contributions we want to retrieve.</span>			</li>
					<li>
				<span class="var-type">$count</span>
				<span class="var-name">$count</span><span class="var-description">: Number of entries to return.  (Default 50)</span>			</li>
					<li>
				<span class="var-type">$dir</span>
				<span class="var-name">&$continue</span><span class="var-description">: Which direction to enumerate from, &quot;older&quot; or &quot;newer&quot;.  (Default 'older')</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$dir</span>			</li>
				</ul>
		
			
	</div>
<a name="methodusers" id="users"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">users</span> (line <span class="line-number">392</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Enumerates user metadata.</p>
	<ul class="tags">
				<li><span class="field">return:</span> array of user metadata.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Associative</span>
		<span class="method-name">
			users
		</span>
					([<span class="var-type">$start</span>&nbsp;<span class="var-name">$start</span> = <span class="var-default">null</span>], [<span class="var-type">$limit</span>&nbsp;<span class="var-name">$limit</span> = <span class="var-default">1</span>], [<span class="var-type">$group</span>&nbsp;<span class="var-name">$group</span> = <span class="var-default">null</span>], [<span class="var-type">$requirestart</span>&nbsp;<span class="var-name">$requirestart</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">&$continue</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">$start</span>
				<span class="var-name">$start</span><span class="var-description">: The username to start enumerating from.  Null means from the beginning.  (Default null)</span>			</li>
					<li>
				<span class="var-type">$limit</span>
				<span class="var-name">$limit</span><span class="var-description">: The number of users to enumerate.  (Default 1)</span>			</li>
					<li>
				<span class="var-type">$group</span>
				<span class="var-name">$group</span><span class="var-description">: The usergroup to filter by.  Null means no filtering.  (Default null)</span>			</li>
					<li>
				<span class="var-type">$requirestart</span>
				<span class="var-name">$requirestart</span><span class="var-description">: Whether or not to require that $start be a valid username.  (Default false)</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">&$continue</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Tue, 31 May 2011 22:21:56 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</p>
	</div></body>
</html>